Intersoft WebTextEditor Documentation
WebTextEditor
Send Feedback
Intersoft WebTextEditor > Client-side References > WebTextEditor

Glossary Item Box

 WebTextEditor Properties

ScriptDirectory Description
Gets or sets the directory where all required scripts for the control are stored.

ValueType


Default Value

ImagesDirectory Description
Gets or sets the images directory.

ValueType


Default Value

ViewStateStorage Description
Gets or sets the location to store the viewstate of this control.

ValueType


Default Value

AccessKey Description
Keyboard shortcut used by the control.

ValueType


Default Value

Enabled Description
Enables state of the control.

ValueType


Default Value

TabIndex Description
The tab order of the control.

ValueType


Default Value

ToolTip Description
The tooltip displayed when the mouse is over the control.

ValueType


Default Value

Width Description
The width of the control.

ValueType


Default Value

Height Description
The height of the control.

ValueType


Default Value

DefaultStyleMode Description
Gets or sets the value that determines the mode of the default style when UseDefaultStyle is enabled.

ValueType


Default Value

AllowDefaultStyleMerging Description
Gets or sets the value that determines whether or not the default style can be merged with custom styles.

ValueType


Default Value

UseDefaultStyle Description
Determines whether WebTextEditor is using default style.

ValueType


Default Value

AllowResize Description
Determines whether resize action is allowed.

ValueType


Default Value

EnableDocumentImport Description
Determines whether document import is enabled.

ValueType


Default Value

EnableDocumentSave Description
Determines whether document save is enabled.

ValueType


Default Value

EnableDocumentPrint Description
Determines whether document print is enabled.

ValueType


Default Value

EnableContextMenu Description
Determines whether context menu is enabled.

ValueType


Default Value

EnableHTMLInspector Description
Determines whether html inspector is enabled.

ValueType


Default Value

EnableKeyboardSupport Description
Determines whether keyboard support is enabled.

ValueType


Default Value

ShowCharacterInformation Description
Determines whether character information should be shown as tooltip.

ValueType


Default Value

ShowWordInformation Description
Determines whether word information should be shown.

ValueType


Default Value

EnableFullScreen Description
Gets or sets the value that determines whether full screen feature is enabled.

ValueType


Default Value

EnableAutoSave Description
Determines whether auto save feature is enabled.

ValueType


Default Value

MinimumSize Description
Gets or sets the value that determines the minimum size of WebTextEditor when it is resized.

ValueType


Default Value

MaximumSize Description
Gets or sets the value that determines the maximum size of WebTextEditor when it is resized.

ValueType


Default Value

UndoLatency Description
Specifies undo latency interal (in milisecond).

ValueType


Default Value

MediaResources Description
The media resources collection used by WebTextEditor to filter the media in Media Gallery task pane.

ValueType


Default Value

RootTextEditor Description
Provides settings that control the behaviors of single section in WebTextEditor.

ValueType


Default Value

TextEditorSections Description
Provides settings that control the behaviors of multiple section in WebTextEditor.

ValueType


Default Value

EnableEditorTabKey Description
Determines whether WebTextEditor should handle Tab key.

ValueType


Default Value

EnterKeyAction Description
Specifies WebTextEditor behavior when enter key is pressed.

ValueType


Default Value

ParagraphMode Description
Specifies the behavior of paragraph editing.

ValueType


Default Value

ShowCallOutOnMediaInsert Description
Determines whether callour will appear when media is inserted.

ValueType


Default Value

ShowMediaActionOnMediaSelect Description
Determines whether media action will appear when media is selected.

ValueType


Default Value

PreventScriptInjection Description
Determines whether script tag is removed from WebTextEditor.

ValueType


Default Value

EnableXHTMLCompliance Description
Determines whether WebTextEditor's output is XHTML compliance.

ValueType


Default Value

ToolBarSettings Description
Provides settings that control the behaviors of the toolbar in WebTextEditor.

ValueType


Default Value

TextSettings Description
Provides settings that control text shown in WebTextEditor.

ValueType


Default Value

ViewSettings Description
Provides settings that control the behaviors of the view in WebTextEditor.

ValueType


Default Value

ImagesSettings Description
Provides settings thta control the images in WebTextEditor.

ValueType


Default Value

TaskPaneSettings Description
Provides settings that control the behaviors of the task pane in WebTextEditor.

ValueType


Default Value

EditorSettings Description
Provides settings that control the behaviors of the editor in WebTextEditor.

ValueType


Default Value

MailMergeSettings Description
Provides settings that control the behaviors of mail merge in WebTextEditor.

ValueType


Default Value

ClientSideEvents Description
Contains Client-side events supported by WebTextEditor.

ValueType


Default Value

 WebTextEditor Methods

GetElement Description
Gets the WebTextEditor element.

Parameters

Remarks

Return Value

Samples

 
GetFrameLayerElement Description
Gets the frame layer element.

Parameters

Remarks

Return Value

Samples

 
GetMainHeaderElement Description
Gets the main header element.

Parameters

Remarks

Return Value

Samples

 
GetHTMLToolBar Description
Gets the HTML toolbar object.

Parameters

Remarks

Return Value

Samples

 
GetMainContentElement Description
Gets the main content element.

Parameters

Remarks

Return Value

Samples

 
GetMainFooterElement Description
Gets the footer element.

Parameters

Remarks

Return Value

Samples


 
GetMainContentFrameElement Description
Gets the footer content element.

Parameters

Remarks

Return Value

Samples

 
GetMainContentTableElement Description
Gets the footer content table element.

Parameters

Remarks

Return Value

Samples

 
GetEditorFrameElement Description
Gets the WebTextEditor frame element.

Parameters


Remarks

Return Value

Samples

 
GetEditorContentFrameElement Description
Gets the WebTextEditor content element.

Parameters

Remarks

Return Value

Samples

 
GetEditorLayerFrameElement Description
Gets the WebTextEditor layer frame element.

Parameters

Remarks

Return Value

Samples

 
GetSplitterElement Description
Gets the splitter element.

Parameters

Remarks

Return Value

Samples

 
GetSplitterIndicatorElement Description
Gets the splitter indicator element.

Parameters

Remarks

Return Value

Samples

 
GetTaskPaneElement Description
Gets the TaskPane element.

Parameters

Remarks

Return Value

Samples

 
SetValueToCurrentPosition Description
Sets value in the last active cursor position.

Parameters

Remarks

Return Value

Samples

 
SetFocus Description
Sets focus on editor.

Parameters

Remarks

Return Value

Samples

 
RegisterIFrameBehavior Description
Registers the behavior to IFrame element.

Parameters

Remarks

Return Value

Samples

 
UnregisterIFrameBehavior Description
Unregisters the events attached to editor iframe.

Parameters

Remarks

Return Value

Samples

 
ToggleToolBar Description
Toggles toolbar elements.

Parameters

Remarks

Return Value

Samples

 
ResetEditorState Description
Resets the editor state.

Parameters

Remarks

Return Value

Samples

 
SetHeaderHeightCache Description
Sets the header height.

Parameters

Remarks

Return Value

Samples

 
HideCallOut Description
Hides the callout manually.

Parameters

Remarks

Return Value

Samples

 
GetViewIndicatorElement Description
Gets the view indicator element.

Parameters

Remarks

Return Value

Samples

 
GetDesignViewTabElement Description
Gets the design view tab element.

Parameters

Remarks

Return Value

Samples

 
GetHTMLViewTabElement Description
Gets the html view tab element.

Parameters

Remarks

Return Value

Samples

 
GetSplitViewTabElement Description
Gets the split view tab element.

Parameters

Remarks

Return Value

Samples

 
GetWordsInformationTabElement Description
Gets the word information tab element.

Parameters

Remarks

Return Value

Samples

 
GetSpellCheckerTabElement Description
Gets the spell checker tab element.

Parameters

Remarks

Return Value

Samples


 
GetHTMLInspectorTabElement Description
Gets the html inspector tab element.

Parameters

Remarks

Return Value

Samples

 
GetHTMLInspectorDivElement Description
Gets the html inspector div element.

Parameters

Remarks

Return Value

Samples

 
GetHTMLInspectorLeftIndicatorElement Description
Gets the html inspector left indicator element.

Parameters


Remarks

Return Value

Samples

 
GetHTMLInspectorRightIndicatorElement Description
Gets the html inspector right indicator element.

Parameters

Remarks

Return Value

Samples

 
GetHTMLInspectorContentElement Description
Gets the html inspector content element.

Parameters

Remarks

Return Value

Samples

 
GetHTMLInspectorContentTableElement Description
Gets the html inspector content table element.

Parameters

Remarks

Return Value

Samples

 
GetUploadBarElement Description
Gets the upload bar element.

Parameters

Remarks

Return Value

Samples

 
GetUploadBarFrameElement Description
Gets the upload bar frame element.

Parameters

Remarks

Return Value

Samples

 
GetUploadBarContentElement Description
Gets the upload bar content element.

Parameters

Remarks

Return Value

Samples

 
GetStatusBarElement Description
Gets the status bar element.

Parameters

Remarks

Return Value

Samples

 
GetResizerElement Description
Gets the resizer element.

Parameters

Remarks

Return Value

Samples

 
GetFloatingToolBarElement Description
Gets the floating toolbar element.

Parameters

Remarks

Return Value

Samples

 
GetMediaActionFrameElement Description
Gets the media action frame element.

Parameters

Remarks

Return Value

Samples

 
CheckSpell Description
Starts check spelling.

Parameters

Remarks

Return Value

Samples

 
RemoveSpellChecker Description
Gets the remove check spell.

Parameters

Remarks

Return Value

Samples

 
GetDesignViewFrameByName Description
Gets design view frame by section name.

Parameters
sectionName

Remarks

Return Value

Samples

 
GetSelectedDesignViewFrame Description
Gets selected design view frame.

Parameters

Remarks

Return Value

Samples

 
GetHtmlViewFrameByName Description
Gets html view by section name.

Parameters
sectionName

Remarks

Return Value

Samples

 
GetSelectedHTMLViewFrame Description
Gets selected html view frame.

Parameters

Remarks

Return Value

Samples

 
ShowDesignViewByName Description
Shows design view by section name.

Parameters
sectionName

Remarks

Return Value

Samples

 
HideDesignViewByName Description
Hides design view by section name.

Parameters
sectionName

Remarks

Return Value

Samples


 
HideHtmlViewByName Description
Hides html view by section name.

Parameters
sectionName

Remarks

Return Value

Samples

 
GetSectionObjectByName Description
Gets section object by name.

Parameters
sectionName

Remarks

Return Value

Samples

 
GetSectionFrameBySectionName Description
Gets section Frame by section name.

Parameters
sectionName

Remarks

Return Value

Samples

 
GetSelectedSectionElement Description
Gets selected section element.

Parameters

Remarks

Return Value

Samples

 
GetSelectedSectionObject Description
Gets selected section object.

Parameters

Remarks

Return Value

Samples

 
GetSelectedSectionElementByName Description
Gets selected section element by section name.

Parameters
sectionName

Remarks

Return Value

Samples

 
GetSectionElementByName Description
Gets section element by name.

Parameters
sectionName

Remarks

Return Value

Samples

 
GetSelectedHtmlSectionElement Description
Gets selected html section element.

Parameters

Remarks

Return Value

Samples

 
GetHtmlSectionElementByName Description
Gets html section element by section name.

Parameters
sectionName

Remarks

Return Value

Samples

 
GetTextAreaBySectionName Description
Gets textarea by section name.

Parameters
sectionName

Remarks

Return Value

Samples

 
GetSelectedTextArea Description
Gets selected textarea from selected html view.

Parameters

Remarks

Return Value

Samples

 
GetSelectedWatermark Description
Gets selected watermark element.

Parameters

Remarks

Return Value

Samples

 
ShowAllWatermark Description
Shows all watermark.

Parameters

Remarks

Return Value

Samples

 
ShowSelectedWatermark Description
Shows selected watermark by name.

Parameters
name

Remarks

Return Value

Samples

 
HideAllWatermark Description
Hides all watermark.

Parameters

Remarks

Return Value

Samples

 
HideSelectedWatermark Description
Hides selected watermark.

Parameters

Remarks

Return Value

Samples

 
GetImageBySectionName Description
Gets image's section by section name.

Parameters
sectionName

Remarks

Return Value

Samples

 
GetSectionTableBySectionName Description
Gets section table element by section name.

Parameters
sectionName

Remarks

Return Value

Samples

 
GetSectionImageFrameBySectionName Description
Get section image frame by section name.

Parameters
sectionName

Remarks

Return Value

Samples

 
GetAllSections Description
Gets all section.

Parameters

Remarks

Return Value

Samples

 
ExecCommand Description
Invokes WebTextEditor exec command.

Parameters
Operation

Remarks

Return Value

Samples

 
TextAreaExecCommand Description
Invokes WebTextEditor's textarea.

Parameters
operation, command, isCloseTag

Remarks

Return Value

Samples

 
InsertTable Description
Inserts table to editor.

Parameters
column, row

Remarks

Return Value

Samples

 
InsertsImage Description
Inserts image to editor.

Parameters
url, width, height, useFrame

Remarks

Return Value

Samples

 
InsertMedia Description
Inserts media such as video to editor.

Parameters
url, width, height, mediaType, isToolBar

Remarks

Return Value

Samples

 
InsertFormControl Description
Inserts form control to editor.

Parameters
command

Remarks

Return Value

Samples

 
SetValue Description
Sets value to editor, sectionName should be empty if it is single section.

Parameters
contentString, sectionName

Remarks

Return Value

Samples

 
GetValue Description
Gets value from editor, sectionName should be empty if it is single section.

Parameters
sectionName

Remarks

Return Value

Samples

 
ShowUploadingProgress Description
Shows uploading progress.

Parameters
percentage, msg

Remarks

Return Value

Samples

 
HideUploadingProgress Description
Hides uploading progress.

Parameters

Remarks

Return Value

Samples

 
RefreshMediaGallery Description
Refresh media gallery.

Parameters

Remarks

Return Value

Samples

 
GetUploadLocations Description
Gets upload locations.

Parameters


Remarks

Return Value

Samples

 
OnToolbarCommandNotify Description


Parameters
commandName, toggleState, enabledState, isFloatingToolbar

Remarks

Return Value

Samples

 
SaveContent Description
Saves WebTextEditor content client side method. If it is single section then sectionName can be empty. sectionName can be specified with "All" if user wants to save all sections.

Parameters
sectionName

Remarks

Return Value

Samples

 
ShowUploadingProgress Description
Shows uploading progress.

Parameters
percentage, msg

Remarks

Return Value

Samples

 
HideUploadingProgress Description
Hides uploading progress.

Parameters

Remarks

Return Value

Samples

 
RefreshMediaGallery Description
Refresh media gallery.

Parameters

Remarks

Return Value

Samples

 
GetUploadLocations Description
Gets upload locations.

Parameters


Remarks

Return Value

Samples

 
OnToolbarCommandNotify Description


Parameters
commandName, toggleState, enabledState, isFloatingToolbar

Remarks

Return Value

Samples

 
SaveContent Description
Saves WebTextEditor content client side method. If it is single section then sectionName can be empty. sectionName can be specified with "All" if user wants to save all sections.

Parameters
sectionName

Remarks

Return Value

Samples

 
©2013. All Rights Reserved.